Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Check for invalid keys #1935

Merged
merged 4 commits into from
Sep 6, 2023
Merged

Check for invalid keys #1935

merged 4 commits into from
Sep 6, 2023

Conversation

muellerzr
Copy link
Collaborator

What does this PR do?

This PR introduces a better error when loading the YAML file in by letting the user know what errors were actually present.

Fixes # (issue)

Helps relieve the confusion when getting errors such as:

ClusterConfig.__init__() got an unexpected keyword argument 'myargument'

And instead results with:

Unknown keys in the config file: ['myargument'], please try upgrading your `accelerate` version or remove them.

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?
  • Was this discussed/approved via a Github issue or the forum? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the
    documentation guidelines, and
    here are tips on formatting docstrings.
  • Did you write any new necessary tests?

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.

@BenjaminBossan

@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Sep 6, 2023 •
edited
Loading

The documentation is not available anymore as the PR was closed or merged.

BenjaminBossan
BenjaminBossan requested changes Sep 6, 2023
View reviewed changes
Copy link
Member

@BenjaminBossan BenjaminBossan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Big 👍 for improving error messages, thanks for that. I have some comments, please take a look.

src/accelerate/commands/config/config_args.py Outdated Show resolved Hide resolved
src/accelerate/commands/config/config_args.py Outdated Show resolved Hide resolved
src/accelerate/commands/config/config_args.py Outdated Show resolved Hide resolved
SunMarc
SunMarc approved these changes Sep 6, 2023
View reviewed changes
Copy link
Member

@SunMarc SunMarc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with @BenjaminBossan comments !

BenjaminBossan
BenjaminBossan approved these changes Sep 6, 2023
View reviewed changes
Copy link
Member

@BenjaminBossan BenjaminBossan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, looks good to me.

Nano-nit, if len(extra_keys) > 0 could be if extra_keys, but I'm totally fine as is.

@muellerzr muellerzr merged commit cec5ae8 into main Sep 6, 2023
24 checks passed
@muellerzr muellerzr deleted the load-config-check branch September 6, 2023 16:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SunMarc SunMarc SunMarc approved these changes

@BenjaminBossan BenjaminBossan BenjaminBossan approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@muellerzr @HuggingFaceDocBuilderDev @BenjaminBossan @SunMarc